docs(api): hide models sidebar in Scalar reference by PierreBrisorgueil · Pull Request #3459 · pierreb-devkit/Node

PierreBrisorgueil · 2026-04-13T10:31:48Z

Summary

Pass hideModels: true to the Scalar apiReference middleware mounted at /api/docs in lib/services/express.js.
The public docs no longer expose the Models sidebar tree (Mongoose-derived shapes, error envelopes, intermediate DTOs). Endpoint schemas are still documented inline on each route — the Models section just leaked implementation detail without helping API consumers.
Stack-side default: every downstream project benefits without extra config.

Verification

hideModels option confirmed against the installed version of @scalar/express-api-reference (0.9.7). The config type is HtmlRenderingConfiguration re-exported from @scalar/core, and node_modules/@scalar/types/dist/api-reference/api-reference-configuration.d.ts declares hideModels: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>> — option name and typing both valid.
Out of scope (kept for a later PR per one-fix-per-PR rule): theme changes, hiddenClients trimming, customCss, layout tuning.

Test plan

npm run lint — green
npm test — 499/499 unit tests passing
Manual sanity check of the diff (one-line addition)
CI green on PR
CodeRabbit review clean

Closes #3458

Summary by CodeRabbit

Documentation
- API reference documentation now hides models in the rendered interface, providing a streamlined view at /api/docs.

Pass `hideModels: true` to the Scalar apiReference middleware so the public `/api/docs` no longer exposes the internal Models tree (Mongoose-derived shapes, error envelopes, intermediate DTOs). Schemas are still documented inline on each endpoint — the Models section just leaks implementation detail without helping API consumers. Stack-side default — every downstream project benefits without extra config. Closes #3458

coderabbitai · 2026-04-13T10:32:01Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 905491d5-7cd4-4473-87f4-3c77640acf6d

📥 Commits

Reviewing files that changed from the base of the PR and between ec216ba and 358488d.

📒 Files selected for processing (1)

lib/services/express.js

Walkthrough

A single configuration option was added to the Scalar API reference UI to hide the Models section by default, preventing exposure of internal schema details in the public-facing API documentation at /api/docs.

Changes

Cohort / File(s)	Summary
Scalar API Configuration `lib/services/express.js`	Added `hideModels: true` option to `apiReference()` configuration to hide the Models sidebar in the Scalar API documentation UI.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main change: adding hideModels configuration to hide the models sidebar in the Scalar API reference documentation.
Description check	✅ Passed	The description covers the summary, verification details, and test plan. Most required template sections are addressed, though the formal Scope, Validation checklist, and Guardrails sections are not strictly formatted per template.
Linked Issues check	✅ Passed	The PR fully addresses the core objective from issue `#3458` by adding hideModels: true to the apiReference config, preventing internal schema exposure while keeping endpoint documentation inline.
Out of Scope Changes check	✅ Passed	The change is a single-line addition to express.js configuration that directly implements the linked issue requirement. No unrelated or out-of-scope modifications are present.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch chore/scalar-hide-models

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Copilot

Pull request overview

This PR updates the Scalar API reference UI configuration to avoid exposing internal schema/model details in the public docs, while keeping endpoint-level request/response schemas visible inline.

Changes:

Pass hideModels: true to the Scalar apiReference middleware mounted at /api/docs.

codecov · 2026-04-13T10:34:22Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.81%. Comparing base (3cc434c) to head (358488d).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #3459   +/-   ##
=======================================
  Coverage   85.81%   85.81%           
=======================================
  Files         115      115           
  Lines        2911     2911           
  Branches      805      805           
=======================================
  Hits         2498     2498           
  Misses        327      327           
  Partials       86       86

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copilot AI review requested due to automatic review settings April 13, 2026 10:31

Copilot started reviewing on behalf of PierreBrisorgueil April 13, 2026 10:32 View session

Copilot AI reviewed Apr 13, 2026

View reviewed changes

coderabbitai bot approved these changes Apr 13, 2026

View reviewed changes

PierreBrisorgueil merged commit 5e91cec into master Apr 13, 2026
9 checks passed

PierreBrisorgueil deleted the chore/scalar-hide-models branch April 13, 2026 10:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs(api): hide models sidebar in Scalar reference#3459

docs(api): hide models sidebar in Scalar reference#3459
PierreBrisorgueil merged 1 commit intomasterfrom
chore/scalar-hide-models

PierreBrisorgueil commented Apr 13, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Apr 13, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

codecov bot commented Apr 13, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

PierreBrisorgueil commented Apr 13, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Verification

Test plan

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

codecov bot commented Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

PierreBrisorgueil commented Apr 13, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 13, 2026 •

edited

Loading

codecov bot commented Apr 13, 2026 •

edited

Loading